home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / bbs / pad321.zip / PADLOCK.DOC < prev    next >
Text File  |  1996-09-21  |  22KB  |  491 lines

  1.  
  2.  
  3.                            P   A   D   L   O   C   K
  4.                -------------------------------------------------
  5.                                  version 3.20
  6.                             (C) 1996 Stefan Xenos
  7.  
  8.  
  9.                              L e g a l   S t u f f
  10.                              _____________________
  11.  
  12.         This software is entirely without warrantly, expressed or implied. 
  13. If you decide to use it, you do so at your own risk. The only thing I
  14. guarantee about it is that it will take up space on your hard disk. I take
  15. no responsibility for anything that happens through your use of this
  16. software, no matter how bad it is.
  17.  
  18.         All of the files included in the Padlock distribution archive are
  19. (C) 1996 Stefan Xenos.
  20.  
  21.         If people weren't in the habit of suing everyone who looked at them
  22. the wrong way, then time and space-wasting messages like this would be
  23. unnecessary.
  24.  
  25.         You may modify this source code however you like for your own
  26. personal use as long as the copyright message and the author's name is not 
  27. removed. You MAY NOT distribute modified versions of the code. You may not 
  28. charge money for the use or distribution of this program without my prior
  29. permission in writing. Feel free to distribute it like crazy as long as you 
  30. don't charge for it.
  31.  
  32.   You may:
  33.  
  34.         - Use Padlock on any sort of electronic bulletin board system,
  35.           even those that charge money for access or provide some
  36.           commercial service.
  37.         - Distribute Padlock on a BBS or through the internet. In fact,
  38.           I'd encourage you to distribute this software like there was
  39.           no tomorrow.
  40.         - Modify the source code for your own personal use.
  41.         - Use portions of Padlock's source code for writing other utilities,
  42.           as long as you don't distribute them without my prior permission
  43.           in writing.
  44.  
  45.   You may do the following only with my prior permission in writing:
  46.  
  47.         - Charge money for the use or distribution of Padlock.
  48.         - Distribute Padlock on CD-ROM or diskette as part of a compilation
  49.           of other shareware and freeware.
  50.         - Include Padlock in the distribution of some other product.
  51.         - Use any part of Padlock's source code in another piece of software
  52.           available publicly.
  53.  
  54.   You may not:
  55.  
  56.         - Take credit for writing Padlock or any portion thereof, no matter
  57.           how much you've modified its source code.
  58.         - Distribute modified versions of Padlock.
  59.         - Add or remove any files to the Padlock distribution archive. This
  60.           includes BBS adds.
  61.         - Remove the copyright notice or author's name from the program.
  62.         - Reproduce the source code in any form.
  63.        
  64.  
  65.         Please remember that this is copyrighted software. Although it is
  66.         free, it is NOT in the public domain. If you've written bug fixes
  67.         or patches for Padlock, please do not distribute them. Instead,
  68.         send them to me for inclusion in the next release, and if I decide
  69.         to include them, you will be credited for your work.
  70.  
  71.  
  72.  
  73.                              I n t r o d u c t i o n
  74.                              _______________________
  75.  
  76.         The document you are reading now was put together in a real rush.
  77. I'm hoping to include better documetation in a future release. If there's 
  78. any die-hard Padlock user out there who would be interested in writing a 
  79. better user's manual for me, I'd be very grateful. <grin>
  80.  
  81.         Padlock is a flexible call back verifier for Maximus 3.xx and up.
  82. It has been written entirely in Mex (The Maximus EXtension Language) to
  83. ensure portability and to enable you to customize it however you want. 
  84.  
  85.         Pleez exkuze my speling. I havint had a chanse to spel chek this
  86. fiel yet.
  87.  
  88.  
  89.                                 F e a t u r e s
  90.                                 _______________
  91.  
  92.         This section describes Padlock's features and describes its behaviour.
  93. If you just want to get started
  94.  
  95.         Padlock's features include:
  96.  
  97.         - Multinode friendly.
  98.         - International phone number support.
  99.         - Padlock can often guess a user's phone number if it is in the
  100.           wrong format.
  101.         - Sysop-definable logic for adding prefixes and suffixes to phone
  102.           numbers from particular areas. 
  103.         - Verifications to different areas can be restricted to particular 
  104.           times of the day.
  105.         - The user's city can be updated based on their phone number.
  106.         - Auto detection of long distance phone numbers.
  107.         - Baudrate checking.
  108.         - Many wildcards are supported for specifying phone numbers in the
  109.           input file.
  110.         - Additional verification attempts can be made if another user tries
  111.           to call the BBS during a verification.
  112.         - Runs under DOS, Win 95, OS/2 2.1, and OS/2 Warp.
  113.         - Most output is done through user-editable .MEC files.
  114.         - Complete Mex source code included.
  115.         - The user's security level can be automatically updated after
  116.           a successful verification. User keys can also be added or removed.
  117.         - Cursor animation and line editing for most user input.
  118.         - Very flexible. Every aspect of Padlock's behaviour is user
  119.           configurable. Padlock can even be set up to duplicate the behaviour
  120.           of most other popular verifiers.
  121.  
  122.  
  123.                      S y s t e m   R e q u i r e m e n t s
  124.                      _____________________________________
  125.  
  126.         In order to run Padlock, you must have the following:
  127.  
  128.         - Maximus CBCS v3.00 or higher. Padlock will NOT run with Maximus 
  129.           versions earlier than version 3, and it will not run with any 
  130.           other BBS package (sorry).
  131.         - An operating system capable of running Maximus 3.00. Padlock
  132.           should be able to run under any environment Maximus can.
  133.         - 500k of hard disk space.
  134.  
  135.         I have tested Padlock 3.00 using the default settings on a Pentium 90
  136.         with a USR Sportster 14.4k under DOS 6.22, OS/2 2.1, OS/2 Warp, and
  137.         Win 95. In addition, OS/2 2.1 and OS/2 Warp were tested with a 
  138.         Zoom 28.8k modem. 
  139.  
  140.  
  141.                            I n s t a l l a t i o n
  142.                            _______________________
  143.  
  144.  
  145. 1.      Move all the files into their own directory. By default, I use a 
  146.         directory inside my main Max directory called PADLOCK. If you
  147.         decide to use another directory name, you will have to make several
  148.         additional changes to your configuration.
  149.  
  150. 2.      Back up all the default control files that come with Padlock
  151.         just in case you change something that doesn't work.
  152.  
  153. 3.      Edit SETTINGS.CFG. This file contains the minimum configuration
  154.         information you will need to get Padlock up and running. If you're
  155.         in a rush to get Padlock running, you can skip to step 4 and finish
  156.         this step later. Otherwise, you should edit the other .CFG
  157.         files in your Padlock directory (especially BEHAVIOR.CFG).
  158.  
  159.         You may also want to edit the file INSETUP.MH, which controls 
  160.         the behaviour of the input/output routines.
  161.  
  162. 4.      Edit the file PHONE.CTL to reflect your local calling area. 
  163.         The default PHONE.CTL is the file I use with my system. It
  164.         contains examples of many different ways to configure your
  165.         system. Follow the instructions in that file for more
  166.         information.
  167.         
  168.         If you don't have the time or patience to configure your local
  169.         calling area, you can use a generic "bare bones" setup. An example
  170.         of such a setup is included in the file SAMPLE.CTL. It should
  171.         work on almost any system with very little editing, but does not
  172.         take advantage of many of Padlock's powerful features. This is
  173.         not recommended, but is useful if you just want to get Padlock
  174.         up and running on a trial basis.
  175.  
  176.         The current version of PHONE.CTL is backwards compatible to 
  177.         version 1.2, so if you are upgrading from any previous version 
  178.         of Padlock you should be able to use your existing PHONE.CTL without 
  179.         any problems. Just rename the default PHONE.CTL that comes with 
  180.         Padlock and copy yours into the padlock directory. 
  181.  
  182. 5.      If you placed Padlock to the default directory, you can
  183.         skip this step. Otherwise, edit all the .MEC files to
  184.         change all uses of the directory name "padlock\" to
  185.         wherever you placed the Padlock files.
  186.  
  187.         You will also need to modify FILENAME.CFG and change
  188.         the keywords message_file_directory, phone_file, and
  189.         log_file to point to the new directory.
  190.  
  191. 5.      If you are using the default directory names for maximus
  192.         and for Padlock, go into the padlock directory and type:
  193.  
  194.         BUILD
  195.  
  196.         Otherwise, type:
  197.  
  198.         BUILD [maximus directory] [mex include directory]
  199.  
  200.         where [maximus directory] is the directory where the maximus
  201.         executables can be found and [mex include directory] is the
  202.         directory where the file MAX.MH and the other default maximus
  203.         header files can be found. By default, these files are placed
  204.         in a directory called "m" inside the main maximus directory.
  205.  
  206.         IMPORTANT !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  207.  
  208.         You MUST run this batch file EVERY TIME you change any of the .MH,
  209.         .CFG, or .MEX files that come with padlock in order for your changes
  210.         to take effect. Forgetting to run BUILD after changing a configuration
  211.         file is by far the most common mistake I've encountered.
  212.  
  213.         !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  214.  
  215. 6.      Connect Padlock to your BBS somehow. To do this, you must
  216.         tell Maximus to display the file padlock.mec to your
  217.         unregistered users. There are two common ways of doing this. 
  218.         The first is to add a menu option to MENUS.CTL which says something 
  219.         like:
  220.  
  221.         display_file    padlock\padlock Demoted "Register"
  222.  
  223.         Another way is to display padlock.mec from inside another mec
  224.         file. By displaying padlock.mec from welcome.mec to all users
  225.         below a certain security level, you can force callers to pass
  226.         through call back verification before they even get to see your
  227.         main menu.
  228.  
  229.         For example:
  230.  
  231.         Add "[keyon]R " to your NEWUSER2.MEC file
  232.  
  233.         Then add the following to WELCOME.MEC:
  234.  
  235.         [notkey]R [link]padlock\padlock
  236.         [notkey]R [hangup]
  237.  
  238.         Then configure PADLOCK to disable the R key after a successful
  239.         verification.
  240.  
  241.                                  P r o b l e m s
  242.                                  _______________
  243.  
  244.         This section covers some common problems and gives suggestions for
  245. solving them. Please read this section to see if your problem is discussed
  246. here before writing me with a bug report.
  247.  
  248. ------------------------------------------------------------------------------
  249. Problem: When Padlock begins, a message appears saying something like:
  250.  
  251. ! 06 Aug 22:13:29 MAX  Cannot find file: padlock\somefile.BBS
  252. Cannot find file: padlock\somefile.BBS. Please report this error to the sysop
  253.  
  254. Solution:
  255.  
  256.         Ensure that all the filenames defined in SETTINGS.MH are correct and
  257. that the files actually exist.
  258.  
  259. ------------------------------------------------------------------------------
  260. Problem: The changes I make in SETTINGS.MH don't seem to have any effect!
  261. Solution:
  262.  
  263.         Remember to run BUILD after making any changes to SETTINGS.MH.
  264.  
  265. ------------------------------------------------------------------------------
  266. Problem: Maximus crashes and I get a message that looks something like this:
  267.  
  268. ════════════════════════════════════════════════════════════════════════════
  269. FATAL ERROR.  The program encountered an exception violation.
  270. Please record the following information and report it to the author.
  271. --> This report is being saved to file '953.trp' in the current directory.
  272. ────────────────────────────────────────────────────────────────────────────
  273.  
  274. type: c0000005 address: 171d5114 time: 3207e748
  275. flags: 00000000 params: [0]=00000001 [1]=0028ee07
  276. cs:eip=005b:171d5114  ss:esp=0053:0008dd1c
  277. cs=005b  ds=0053  es=0053  fs=150b  gs=0000 ss=0053
  278. eax=0028ee07  ebx=000004d0  ecx=000004d0  edx=00000000
  279. esi=ffffffff  edi=001c585d ebp=0008dd38  efl=00092202
  280. ESPd: 15421d17d347290007ee280051291d1730002b0058dd0800000000008cdd0800
  281. EBPd: 8cdd08005d581c00ffffffffd3472900f0000000550a1d170000791300002900
  282. EIPd: 3810a8037409881040c1ca084975f351c1e902e81b0000005983e103740e8810
  283. Stk at 171d5114:
  284. 001c585d 001c585d 001c585d 001c585d 00051353
  285. 0004f921 0004f3dd 0004f0b4 0004edbc 0005921b
  286. 00058fee 00037b85 0003
  287. The BBS has ended for unknown reasons.
  288. Please wait while an attempt is made to record this bad news...
  289. Thank you.
  290. MsgAPI is closing an open area...
  291. MsgAPI is done closing areas.
  292. SYS1808:
  293. The process has stopped.  The software diagnostic
  294. code (exception code) is  0005.
  295.  
  296. Solution:
  297.  
  298.         This is caused by a bug in Maximus, not Padlock. Maximus seems to
  299. crash when calling certain small Mex functions (don't ask me why). I think
  300. I've managed to avoid this bug while writing Padlock, so this shouldn't 
  301. happen. If you get this error, please report it to me and I'll try to write
  302. a work-around. Be sure to give me enough information to reproduce the problem.
  303.  
  304. ------------------------------------------------------------------------------
  305. Problem: Padlock takes "forever" to dial out the first time.
  306. Solution:
  307.  
  308.         You don't have enough of a delay after your hangup command. Try adding
  309. a few "~"s to the end of your hangup string. This may also be due to problems
  310. in your init string. Try adding a delay to the end of your init string or just
  311. using a blank init string to see if that works - most modems don't require any
  312. init string at all.
  313.  
  314. ------------------------------------------------------------------------------
  315. Problem: I get errors when I run BUILD.
  316. Solution:
  317.  
  318.         You've probably made a typing mistake while editing SETTINGS.MH. Try
  319. restoring the default SETTINGS.MH file that came with the distribution archive
  320. and making your changes a few at a time until you find where your problem was.
  321. You may also get this error if you've modified the Padlock source code. In 
  322. this case, the error probably has something to do with whatever changes you've
  323. made.
  324.  
  325. ------------------------------------------------------------------------------
  326. Problem: There are no .EXE files in the Padlock distribution archive!
  327. Solution:
  328.  
  329.         There aren't supposed to be any executables. Padlock is a Maximus
  330. add-on. It works in much the same way as your .MEC files do. You can compile
  331. and run the files here from within Maximus, without requiring an external
  332. .EXE. This makes Padlock more reliable, and portable. It also means that if
  333. you're already familiar with MECCA or MEX programming, you can totally 
  334. reconfigure Padlock to make it do whatever you like.
  335.  
  336. ------------------------------------------------------------------------------
  337.  
  338.                             U s e r   C o m m e n t s
  339.                             _________________________
  340.  
  341.         I've received a lot of positive feedback about Padlock. I liked these
  342.         ones so much that I just had to quote them here.
  343.  
  344. ------------------------------------------------------------------------------
  345.    From: Raymond Cool                         
  346.      To: Stefan Xenos                         
  347. Subject: Callback verifier
  348.  
  349.  I've been waiting for a good, simple, yet flexible Call-Back Verification 
  350. system, and I must say that yours is what I've been waiting for!  It's fast, 
  351. easy, and even the stupidest of my callers has managed to use it without a 
  352. glitch.
  353.  
  354.  What's your next project?  
  355.  
  356. -Ray
  357.  
  358. --- Maximus/2 3.01
  359.  * Origin: Covenant BBS   Tacoma, Washington (1:138/228)
  360.  
  361. ------------------------------------------------------------------------------
  362.    From: Joe Negron
  363.      To: Stefan Xenos
  364. Subject: Padlock v2.00
  365.  
  366. Just finished installing Padlock 2.0 - nice work!  It's working great
  367. (thus far! :) and is an impressive piece of coding (hats off to Scott
  368. also for including something as powerful as MEX in Maximus).
  369.  
  370. --- Maximus/2 3.01
  371.  * Origin: The Programmer's Mark * Brooklyn, NY, USA: 718-921-9267 (1:278/216)
  372.  
  373.  
  374.         Thanks, guys. It's hearing things like this that make all this effort
  375.         worthwhile.
  376.  
  377.  
  378.                                  S u p p o r t
  379.                                  _____________
  380.  
  381.         I tend to fix bugs quite quickly, so if you report a bug, I'll 
  382.         probably have it patched an a new version released before long. Just
  383.         be sure to tell me in detail what the problem is. It may also be a
  384.         good idea to include a copy of your input files in your bug report so
  385.         that I can test them out myself.
  386.  
  387.         If you have any suggestions, improvements, criticisms, etc.,
  388.         please get in touch. If you think you've made significant
  389.         improvements to my code, please send it my way and I may include
  390.         it in the next release (along with appropriate credit, of course).
  391.         I encourage user feedback. If you have anything to suggest for a
  392.         future version of this software, please let me know. Many of the
  393.         new features in this version were suggested by users. Keep the
  394.         feedback coming, good or bad.
  395.  
  396.         Padlock is entirely free. You don't have to pay a cent for its use.
  397.         I wrote it for the pleasure of doing so, not to make any money. If
  398.         you feel that it is worth something to you, though, you're welcome
  399.         to send a donation my way. If nothing else, this will encourage me
  400.         to continue supporting this product and write more maximus add-ons
  401.         in the future.
  402.  
  403.                            D i s t r i b u t i o n
  404.                            _______________________
  405.  
  406.         You can always pick up the latest version of Padlock by:
  407.  
  408.         - Calling Hyper BBS at (613) 257-7636 and logging on as Guest.
  409.         - File requesting PADLOCK from 1:163/557.0
  410.  
  411.         Several other sysops have also kindly volunteered their services as
  412.         distribution sites, but as of this writing I still haven't figured
  413.         out how I'm going to get new versions to them. In the near future,
  414.         you may also be able to pick up Padlock from:
  415.  
  416.         System name: The Programmer's Mark
  417.               Sysop: Joe Negron
  418.            Location: Brooklyn, NY, USA
  419.        Phone number: (718) 921-9267
  420.        Fido address: 1:278/216
  421.              Action: If you are in the fidonet nodelist, F'req PADLOCK.
  422.                      Otherwise, download it from the BBS.
  423.  
  424.         System name: The Barrack's Rat BBS ][
  425.               Sysop: Michael Andrews
  426.        Fido address: 1:260/801
  427.  
  428.               Sysop: John Medland
  429.        Fido address: 1:250/840
  430.  
  431.         System name: The Vented Spleen
  432.               Sysop: Tony Summerfelt
  433.        Fido address: 1:249/139 or 1:249/100
  434.        Phone number: (613) 544-9332
  435.              Action: F'req "PADLOCK" or "PADxxx.ARJ", where xxx is the version
  436.                      number.
  437.  
  438.  
  439.                                 C o n t a c t
  440.                                 _____________
  441.  
  442.         I can be reached at the following coordinates:
  443.  
  444.         Fidonet netmail:        1:163/557.2
  445.  
  446.         Hyper BBS:              (613)257-7636
  447.                                 Long distance callers should log on as "Guest"
  448.                                 and leave a comment to sysop
  449.  
  450.         Snail mail:             Stefan Xenos
  451.                                 Almonte, Ont.
  452.                                 Canada
  453.                                 K0A 1A0
  454.  
  455.         I can also usually be reached on any of the following fidonet
  456.         echos: MECCA, MUFFIN, MAX_UTIL
  457.  
  458.         Please address any electronic correspondence to either Stefan Xenos
  459.         or Cyclone. Snail mail should only be addressed to Stefan Xenos.
  460.  
  461.  
  462.                                 C r e d i t s
  463.                                 _____________
  464.  
  465.         Padlock is written, designed, maintained, debugged, and supported by
  466.         Stefan Xenos. Special thanks go to:
  467.  
  468.         Will Schweizer, for all the testing he did for me. If he hadn't gone
  469.         through the verifier about a thousand times with different terminal 
  470.         programs and modems, this program would have never seen its first
  471.         release. Will, thanks a lot for your patience.
  472.  
  473.         David Mackintosh, for running the primary Padlock distribution site
  474.         and putting up with me no matter how many new releases I sent him
  475.         in a short period of time.
  476.  
  477.         John Medland, for his excellent beta testing and feedback.
  478.  
  479.         Joe Negron, who suggested adding the Padlock log file.
  480.  
  481.         Everyone who wrote me with a detailed bug report, suggestion,
  482.         or bit of encouragement. Since there's been so many of you I can't
  483.         possibly list you all, but among others I'd like to thank:
  484.  
  485.         Michael Andrews         Joel Bergen             Tony Summerfelt
  486.  
  487.         Padlock users everywhere. I hope you continue to find this software
  488.         useful and keep recommending it to your friends.
  489.  
  490.  
  491.